-
Notifications
You must be signed in to change notification settings - Fork 35
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
White space for forcing carriage return in a paragraph #77
Conversation
Why do you want to force new lines in the middle of paragraphs ? depending on how much width there is, that may be sub optimal |
I think that:
is less readable as:
As each line is a different part of the definition. Having a different paragraph for each line would be too much. another problematic example is:
It is very difficult to read (for me: it is impossible to understand, I just see a single formula with two
From my point of view the current version (all on 1 line, same separator between a part of the formula and another formula, i.e. space) is not understandable as a definition of of This is definitely very subjective, we can abandon this change if nobody else thinks it is useful. The opposite idea would be to remove the carriage returns in the Markdown source as the Markdown version makes thinking that there is a carriage return where there is no carriage return. Maybe at least keeping modification for formulas ( |
The formular in your example a bit slow to parse in both cases. There are 4 things the text conveys to the reader, 1. what it is, 2. what is stored (delta mod 8 from some predictor), 3. the predictor, 4. the context used for the coder. I agree the newline makes it better in this case but it still intermingles things and isnt very clear |
Status of this? It appears that @JeromeMartinez's addition of spacing for line breaks makes it more readable. @michaelni points out that it could be more readable, but that could occur in a subsequent commit and doesn't have to block this. |
Sorry, I inadvertently deleted the branch. |
this doesnt apply cleanly anymore |
2e63fa4
to
589096e
Compare
589096e
to
dee437f
Compare
Branch rebased. |
When I filled the spec with carriage returns in a paragraph with Markdown, my goal was to output a carriage return in HTML. Actually not the case.
This commit fixes that, adding carriage returns.
Reference for how to put a carriage return in Markdown: https://markdown-guide.readthedocs.io/en/latest/basics.html#line-return
Example of issue: all on the same line on https://github.com/FFmpeg/FFV1/blob/master/ffv1.md#quant_table_set_count, split in 3 lines on https://github.com/MediaArea/FFV1/blob/Markdown/ffv1.md#quant_table_set_count.